home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
rbbs_pc
/
becproto.zip
/
SK&J0126.ZIP
/
SUPERK.DOC
< prev
Wrap
Text File
|
1989-01-26
|
29KB
|
609 lines
SuperK v3.16 MiniNet's External Protocol Driver
Protocols Supported: Xmodem Checksum, Xmodem CRC, Ymodem (1k Xmodem) CRC
WXmodem, K9Xmodem and Super8K - Batch or Single File
Copyright 12/4/1986, 1989 by Crater Rim Software. All Rights Reserved.
= = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
SuperK Licensing Agreement
--------------------------
This program is the sole property of Crater Rim Software. For the
sake of clarity, all references and restrictions to the use of SuperK
also apply to any and all of the associated support files (included
with or created by) SuperK.
SuperK, its overlays and all of its associated support files are not
public domain software, nor are they free software. SuperK is
copyright (c) 1988 by Crater Rim Software. All rights reserved.
Users are granted a limited license to use SuperK free of charge BUT
subject to the following limitations:
No user may modify SuperK in any way, including but not limited
to decompiling, disassembling or otherwise reverse engineering
the program.
SuperK must be copied in unmodified form, complete with the file
containing this license information.
Any and all SuperK documentation must be included with the copy.
No fee, charge or other compensation may be accepted or
requested by any licensee.
SuperK may not be distributed in conjunction with any other
product without prior arrangements with Crater Rim Software.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
********* ALL THIS IS SAYING IS THAT I WANT TO KNOW WHO HAS *********
********* (and is using) THIS FILE! NOTHING MORE... *********
* *
* Operators of electronic bulletin board systems (Sysops) may post *
* SuperK for downloading by their users and may use the SuperK *
* module only as long as the above conditions are met and Crater *
* Rim Software has been notified of your intent to use SuperK *
* *
******** ALL THIS IS SAYING IS THAT I WANT TO KNOW WHO HAS **********
******** (and is using) THIS FILE! NOTHING MORE... **********
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Those organizations who distribute public domain or user supported
software on a pay per diskette basis may distribute copies of SuperK
under the above conditions ONLY AFTER OBTAINING WRITTEN PERMISSION
from Crater Rim Software. Such permission usually is granted.
Please write or call for details.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Software Discalaimer and Warranty
Crater Rim Software makes no warranty of any kind, express or
implied, including without limitation, any warranties of
merchantability and/or fitness for a particular purpose. Crater Rim
Software shall not be liable for any damages, whether direct,
indirect, special or consequential arising from a failure of this
program to operate in the manner desired by the user. Crater Rim
Software shall not be liable for any damage to data or property which
may be caused directly or indirectly by use of the program.
IN NO EVENT WILL Crater Rim Software BE LIABLE TO YOU FOR ANY
DAMAGES, INCLUDING ANY LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL
OR CONSEQUENTIAL DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO USE
THE PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY.
= = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
SuperK External Protocol Driver - Revision Log
V2.50 - Dated 08/22/88 Initial Release
V2.52 - Dated 09/01/88
V3.10 - Dated 11/05/88
V3.12 - Dated 12/04/88
V3.13 - Dated 12/06/88
V3.14 - Dated 12/27/88
V3.15 - Dated 01/07/89
V3.16 - Dated 01/26/89
Corrected a slight bug in which SuperK would report an abnormal
CPS count. I suspect this was caused by an immediate abort or by
a transfer which began before midnight and ended after midnight.
In any case, SuperK will report a 1 byte CPS in these cases.
Added the node charcater to the transfer window frame for those
SysOps who are operating multiple nodes in a networking
environment.
Added ErrorLevel exit. If ALL transfers are successful, SuperK
will return an ERRORLEVEL 0 If ANY ONE of the transfers are
not successful, SuperK will return an ERRORLEVEL 1
SuperK v3.15 MiniNet's External Protocol Driver
Command line parameters :
M Monitor Carrier, abort if not present. Including this
parameter allows you to use SuperK to transfer files between
systems via null modem cable. Default is ON (Monitor
Carrier).
Dx Direction of transfer. Where x = R (receive) or S (send)
Px Comm Port to use. Where x = 1 or 2
Sbaud Modem Speed. Where baud = 300, 1200, 2400, 4800, 9600, 19200
Tp[b][y] Protocol to use.
Where p = X = Xmodem
C = CRC Xmodem
Y = Ymodem (1k Xmodem)
W = WXmodem
K = K9Xmodem
S = Super8K
b = Performing the transfer in Batch mode. Note
that both computers MUST be using SuperK in
order for the Batch mode to be operational.
y = SuperK allows you to specify if you want
overwriting of existing files to be performed.
By including a Y with the Tp parameter, the
default overwrite setting will be reversed
during the current BATCH transfer.
In single file mode, the X, C, W and Y protocols are fully
compatible with their counterparts used on all/most BBS
Both systems must be using SuperK to invoke the K9Xmodem
or Super8K Protocols.
Both y and b are optional. The y overwrite reversal
only works in Batch mode (when the b is also present).
If the b is omitted, SuperK defaults to single file mode
A brand new protocol!!! As is the case with the other
SuperK protocols, the Super8K protocol itself may be
executed in either Batch (TSB paramter) or Single File (TS
parameter) mode. Along with a much improved throughput,
the Super8K protocol also rounds file sizes up to the next
higher 128 byte sector, ala X/WXmodem, rather than the
next higher 1K byte sector, ala Y/K9Xmodem.
Super8K uses an 8K block with a 1K error fallback/restart
and since it IS NOT a windowing protocol (like WXmodem and
K9Xmodem), the error/abort response time is improved 1000
fold! Super8K also passes the number of file sectors to
the receiving system so a file size and transfer time
(approxomate) is displayed on both the sending and
receiving systems.
Of course, the Super8K protocol has its own colors so be
sure to setup SuperK before you use it.
Since Super8K only does a byte count update each 8K, the
tranfer may seem to be taking a long time... but in
reality.... the following SUPERK.LOG extract displays the
preliminary test results for each of the SuperK protocols
and a test comparison to Zmodem and Jmodem. These tests
were run between two AT's via Null Modem cable. Results
via modem will probably be a little lower accross the
board.
Size Speed Cps Errors BlkSize Protocol
--------------------------------------------------------------
60800 9600 bps 533 cps 0 errors 0 128 Xmodem Batch
60800 9600 bps 769 cps 0 errors 0 128 WXmodem Batch
61440 9600 bps 787 cps 0 errors 0 1024 Ymodem Batch
61440 9600 bps 869 cps 0 errors 0 1024 K9Xmodem Batch
60707 9600 bps 861 cps 0 errors 0 1024 Zmodem
60800 9600 bps 965 cps 0 errors 0 8192 Super8K Batch
60707 2400 bps 223 cps 0 errors 0 1024 Jmodem
60707 2400 bps 222 cps 0 errors 0 1024 Zmodem
60800 2400 bps 262 cps 0 errors 0 8192 Super8K Batch
---------------------------------------------------------------
Nx Node Letter or Number. Where x = A to Z or 0 to 9
E The E parameter toggles the status of the "erase" flag. If
specified on the command line, SuperK will not erase the
BATCHLST file it creates when multiple filenames are
specified on the command line (until the next time you
specify multiple filenames, that is!)
R This Command Line Paramter is for use with RBBS-PC. RBBS-PC
utilizes a true Batch download with a single file mode
upload. During uploads, RBBS-PC includes the full path and
filename for the f paramter. Since SuperK Batch modes are
TRUE Batch in both downloads and uploads, I have added the R
command line switch to tell SuperK that the F parameter may
(or may not) include a filename. When SuperK sees the R
parameter, it will look for the last \ or : characters and
parse all character after that, thus leaving just the
download path... which it then appends to any uploads. The
default is True (non RBBS-PC) batch uploads.
RBBS command line for Batch Receive using K9Xmodem Batch
SUPERK.COM p[PORT#] s[BAUD] dr r n[NODE] tkb f [FILE]
RBBS command line for Batch Receive using K9Xmodem Batch
SUPERK.COM p[PORT#] s[BAUD] ds r n[NODE] tkb f [FILE]
example: RBBS-PC passes [FILE] as C:\RBBS\99\filename.ext
(or your defined upload path) during uploads
exclusion of the R command line parameter results in an
invalid file specification of
C:\RBBS\99\filename.ext\
inclusion of the R command line parameter results in a valid
file specification of
C:\RBBS\99\
for obvious reasons, if you use the R command line
parameter, you must include the last \ or at least one
superflous (non \ or : character) at the end of the F
specification.
when using the R paramter...
valid C:\RBBS\99\*.* results in C:\RBBS\99\
valid C:\RBBS\99\ABC.PAK results in C:\RBBS\99\
valid C:\RBBS\99\ results in C:\RBBS\99\
invalid C:\RBBS\99 results in C:\RBBS\
no f parameter results in *.* (all files saved
in logged drive\dir)
when using the default (non RBBS-PC)
invalid C:\RBBS\99\*.* results in C:\RBBS\99\*.*\
invalid C:\RBBS\99\ABC.PAK results in C:\RBBS\99\ABC.PAK\
valid C:\RBBS\99\ results in C:\RBBS\99\
valid C:\RBBS\99 results in C:\RBBS\99\
no f parameter results in *.* (all files saved
in logged drive\dir)
F This parameter acts as a flag for SuperK and denotes that
ALL paramters after the F are to be interpreted as
filenames. For obvious reasons, this parameter should be the
last on specified (before the filenames)! Each filename may
contain a full path in the form:
[d:\path\]Filename [d:\path\]Filename to send/receive.
or
You may also specify the use of a text file containing a
list of filenames. Each filename in the list may contain a
full path. This option is specified as:
@drive:\path\Filelist of files to Batch send.
or
You may want to use the second option for file lists... that
is, include a second path where ALL of the files within the
list reside. This option is specified as:
@drive:\path\listfilename@drive:\path
@ Modify colors/logfile name/xferfile name/options flags...
Clone SUPERK.COM if changes are made
The D, P, S and T parameters MUST be supplied... if operating in
single file mode, the F parameter must be supplied. The B, E, Y, M, N
and R parameters are optional... and the @ parameter is only used to
review/modify the default settings (see modification mode below).
The DR and DS parameters are mutually exclusive (only one, but not
both)
Command Line parameters may be supplied as upper or lower case, and
may be entered in any order (except for the F paramter which must be
the last one... before any filenames).
SUPERK.LOG - SuperK will record transfer results to the logfile in the
following format:
+--- Transfer Direction
| +------- File Size (0 if transfer fails)
| | +---------- Modem Speed
| | | +---------- CPS efficiency (0 if transfer fails)
| | | | +------------- Number of errors
| | | | | +-- Dummy for DSZLOG compatability
| | | | | | +----- Packet size in bytes
| | | | | | | +--- Filename
| | | | | | | | Protocol ----++- Batch
| | | | | | | | ||
S 27648 1200 bps 108 cps 0 errors 0 1024 C:\DLS\SUPERK.PAK KB
XFER.TXT - If (and only if) a Node character is specified OR a question
mark is used within the XferFile name or SuperK Log file
name, SuperK will also create a Xfer Node File to show
success/failure status messages.
This file has the following format :
Filename
Upload or Download
Protocol (X/C/Y/W/K/S/XB/CB/YB/WB/KB/SB)
Success or Fail
EOF (^Z)
Sample:
SUPERK.PAK
Download
KB
Success
^Z
The file will be created in the default directory if no drive/path is
specified during the command line @ parameter modification mode.
While in batch mode, only the first file transfer results will be
logged to this file. However, SUPERK.LOG will contain the results of
all files transferred in the batch.
Command Line @ Parameter Modification Mode.
Starting SuperK with the @ command line parameter will put SuperK
into its default modification mode. SuperK will first display its
current default settings and then prompt you for any changes you may
wish to make. Note that entering a blank line (simply hitting
[Enter]) will leave the current setting intact. SuperK allows
modification to the colors it uses, the logfile name, the xfer file
name (for BBS use) and certain operational flags.
C - Modifying colors:
This one's easy! After selecting the C option, SuperK will
display the 127 color palette that it supports. Simply select a
number for each of the 5 colors used... SuperK will cycle
through all 5 colors, updating the "current settings"
accordingly. If you don't want to change a current color
setting, simply hit the [Enter] key and SuperK will move on to
the next setting. The 5 color types are:
Xcolors for Xmodem/Xmodem CRC/WXmodem transfers
Kcolors for K9Xmodem transfers
Ycolors for Ymodem transfers
Scolors for SuperK transfers
Ucolors for universal display of the SuperK logo and batch
filenames
L - Logfile Name:
This is the filename SuperK uses to record the results of any
tranfers it performs. SuperK will accept upto 40 characters so
you may include a full drive:\path\ along with the logfile name.
Additionally, you may use a question mark (?) as one (and only
one) of the logfile name characters. If a question mark is
present, SuperK will substitute the Node character in its place.
If no node character is specified, SuperK will use the letter A
as a Node character. The letter A is substituted ONLY if the
question mark is encountered in the logfile name. If you do not
want SuperK to maintain a logfile, simply enter a backslash (\)..
which will inform SuperK to blank out the logfile name. The
default logfile name is SUPERK.LOG
X - XferFile Name:
This is the filename SuperK uses to record transfer results for
use by BBS programs. Its format and modification is identical to
the Logfile Name. The default Xferfile name is XFER.TXT
O - Overwrite:
This flag setting tells SuperK whether or not in can overwrite
existing files during Batch mode transfers. The default is NO
S - Save Aborts:
This flag setting tell SuperK whether or not it should keep any
partial files which were aborted during transfer. This flag holds
for any protocol - batch or single file mode. The default is YES
W - Write On 0:
This flag setting tells SuperK whether or not it should create
the XferFile when a transfer is not successfully completed. The
status of this flag is the last check that SuperK makes before
creating the XferFile. A node character and XferFile Name must be
specified before the Write On 0 flag comes into play. The default
is YES
[Enter] Quit:
If you only wish to view the current default settings, simply hit
[Enter] to exit back to DOS. If any changes have been made,
SuperK will go into its cloning mode and ask if you want to clone
SuperK to preserve the new changes. Note that you MUST press the
Y key in order to clone SuperK. Hitting [Enter] here will simply
return you to DOS without saving your changes within the SuperK
program.
Program control keys:
SuperK will recognize either the [Esc] key or ^X (control X) key
during transfers and will abort the current transfer, returning
you to DOS. Note that the streaming protocols (Wxmodem,
K9Xmodem) may require several [Esc] or ^X to abort the transfer.
Batch transfers:
SuperK is capable of sending and receiving multiple files in
batch mode. Since this protocol driver was written for use with
my MiniNet BBS package... the sending of the file creation date
(ala DSZ and Telink) tends to drive me up the wall, creating
quite a bit of confusion in keeeping track of newly acquired
files!
For this reason the major difference between SuperK Batch mode
and other Batch modes is that SuperK Batch only sends the File
Name and does not send the file size or file creation date.
During Batch mode transfers, SuperK will display the last 3 files
requested under the SuperK logo so that you may have a running
update of what's happening. The present transfer progress is
displayed in its own window alongside the SuperK logo.
SuperK is able to handle multiple filenames on the command line.
The command syntax remains the same but if more than one filename
is specified, SuperK will create its own BATCHLST file. If a Node
character is specified on the command line, that character will
be used for the extension of BATCHLST. The default is "A" if no
node character is specified.
The number of filenames that can be specified will depend largely
on your own particular system setup, the string length used by
your calling program and the individual filename lengths.
This feature is only active while in Batch Send Mode (receive
automatically gets filename from sender), the command line
paramaters can be in any order, NO WILDCARDS ARE ALLOWED, the
first filename MUST be preceeded by an F (upper or lower case)
and EACH filename may include a full path.
Your command line should look like ...
SUPERK p1 s9600 dS tWB f FILE1 FILE2 FILE3
Since the BATCHLST is created internally (by SuperK), SuperK will
erase the BATCHLST file once it is done with it... You may
override this by including an E as one of the command line
paramters. The E parameter toggles the status of the "erase"
flag. If specified on the command line, SuperK will not erase the
BATCHLST file (until the next time you specify multiple
filenames, that is!)
New with v3.00 is the ability to supply an external path when
using the @C:filelist option in either batch upload or download
modes. The format is @drive:\path\filelist@drive:\path
Receiving files in Batch mode:
You do not have to supply any filename during batch mode
receives. You may of course, include a full drive:\path\ in place
of a filename. Use the F command line parameter to designate the
path in the form: f C:\FOO\BAR (with or without the trailing
backslash). And... DO NOT specify the f parameter if no path or
filename is specified.
Sending files in batch mode:
You may use any valid DOS wildcard configuration with the F
parameter.
Additionally, you may specify a list of filenames for SuperK to
send. The list filename is specified as @C:listfilename
You may of course, include a full drive:\path\ when using the @
option.
The filenames in the list may contain a full drive:\path\ (the
same or different) for each filename.
SuperK is capable of reading and extracting filenames from a
standard - single line - BBS files listing. If you use a BBS
type files listing, and call SuperK from the comm or BBS
directory, you will have to add the full drive:\path\ to each
filename in the list if the files to send do not reside in the
default directory. There are other ways of accessing files that
reside in directories other than the default (default upload and
download directories, etc.), but I won't go into this area as
most comm and BBS programs do this work for you (K9X does it ALL
for you... automatically!)
Examples:
1. Use COM1, 1200 baud, Xmodem, Send files MYFILE.DOC and FILE.COM
SUPERK p1 s1200 tX dS f MYFILE.DOC FILE.COM
2. Use COM2, 19200 baud, Ymodem Batch, Receive file *.DOC, do not
monitor carrier, override the default "do not overwrite".
SUPERK p2 s19200 tYBY dR m
Note: The protocol character must follow the t. The second Y
above is the override for the overwrite flag. The B and
second Y may be in any order just as long as they are the
third and fourth characters in the t parameter.
3. Use COM1, 9600 baud, K9Xmodem Batch Send files in MYLIST.LST
which resides in my C:\BBS\ directory. The files listed in
MYLIST.LST reside in various directories on different drives. Do
not monitor carrier and record success results to Node A of my
BBS.
SUPERK p1 s9600 tKB dS m nA f @C:\BBS\MYLIST.LST
C:\BBS\MYLIST.LST looks like this:
ABC.PAK (this one resides in the default directory)
D:\FOO\BAR\MYGAME.EXE
E:\LOTUS\123GRAPH.PAK
XFER.TXT (or XFERA.TXT if ? specified in the default xferfile
name) will reflect the results of the transfer. Note that only
the first filename and its transfer results will be present in
XFER.TXT. SUPERK.LOG will however, contain the results of all
three files.
4. Use COM2, 19200 baud, K9Xmodem Batch Send only files containing
an PAK extension and residing in my C:\DLS directory, and don't
monitor carrier.
SUPERK p2 s19200 tKB dS m f C:\DLS\*.PAK
5. Use COM2, 19200 baud, K9Xmodem Batch Receive files - store them
in my C:\DLS directory.
SUPERK p2 s19200 tKB dR f C:\DLS
There are 3 sample batch files included in SUPERK.PAK
SEND.BAT - this batch file is set up for sending file(s) to
another system
RECV.BAT - this batch file is set up to receive file(s) from
another system
SUPER.BAT - this batch file will handle transfers in either
direction
Executing any one of the batch files without any parameters (or the
wrong parameter) will display a short message showing the correct
calling procedure and parameter choices. Since SUPER.BAT handles
transfers in either Send or Receive mode, it naturally requires more
information in order to perform correctly.
NOTE: If you are operating a MiniNet BBS v18.00 or above... or K9X v8.20
or above... access to SuperK is handled internally and does not
require the use of the batch files.
If you are not... please read the enclosed PRODUCTS.TXT file...
It's worth a look!
For pure BBS'ing, K9X can't be beat!
------------------------------------------------------------------------------
I have been using this protocol driver on Underdog's MiniNet for
quite some time now. If you need more information on the various
transfer protocols, please get a copy of K9X (my comm program) and
review the K9X.DOC file contained in that package. All suggestions
are gratefully received and reviewed! Let me know...
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
N O T I C E N O T I C E N O T I C E N O T I C E N O T I C E
Due to the amount of time and money I have spent setting up SuperK for
use with your Comm/BBS programs, I am requesting that you please send a
small contribution ($25.00 suggested) to compensate for the man hours I
have spent developing, modifying and setting up this protocol driver.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Sal Manaro dba Crater Rim Softare
4028 41st Ave South
Seattle, Wa 98118 USA
(206) 723-6728 voice
Underdog's MiniNet (206) 725-9233
1200/2400/9600 24hrs 600 megs OnLine
Supporting 22 files transfer protocols!
Enjoy,
Sal Manaro